home *** CD-ROM | disk | FTP | other *** search
/ 3D Images / 3D Images.iso / programs / amiga / smovie / smovie.manual < prev    next >
Encoding:
Text File  |  1995-01-12  |  7.5 KB  |  203 lines
  1. |onc
  2. |lns 3,640,0
  3. |col 0,1
  4. * sMOVIE  Manual *
  5. |col 1,0
  6. |ofc
  7. |tab 4
  8.  
  9. This file lists sMOVIES commands in alphabetical order.
  10. If you have a printer, it's worth printing this one out.
  11.  
  12. All sMOVIEs commands are prefixed with a special character.
  13. This character defaults to '|'.  If you need to print '|'
  14. characters at the start of a line, you can use the ESC command.
  15.  
  16. Any line that does not begin with the special character is
  17. treated as printable text, and will be scrolled onto the
  18. bottom of the display.
  19.  
  20. After the special character comes the command which is always
  21. three letters long.  The letters can be UPPER CASE, lower case,
  22. or AnY COmbINatiOn.  After some commands you need to specify
  23. parameters.  The first parameter should be seperated from the
  24. command by one or more spaces.  Parameters should be seperated
  25. from each other by a comma, and/or spaces.  After the last
  26. parameter a comment is optional.  Comments should be preceded
  27. by a space or semi-colon.
  28.  
  29. O.K. here they are...
  30.  
  31.  
  32. Command: CLR/CLS    Function:    Clears screen.
  33.                     Parameters:    None.
  34.  
  35.     Clears the screen to the current background colour.
  36.  
  37. Command: COL        Function:    Set current colours.
  38.                     Parameters:    Pen colour,Background colour.
  39.  
  40.     Specifies the colour numbers to be used for text etc.
  41.     Use the PLT command to assign a colour to a colour number.
  42.  
  43. Command: COM        Function:    Comment.
  44.                     Parameters:    None.
  45.  
  46.     Lets you add non-printing comments to your files.
  47.  
  48. Command: DEP        Function:    Sets maximum number of colours.
  49.                     Parameters:    Number of bitplanes to use.
  50.  
  51.     DEP lets you specify how many colours will be available on
  52.     the screen at the same time.  If you want four colours at 
  53.     once use 'dep 2', 'dep 3' gives you eight colours, and 
  54.     'dep 4' the maximum sixteen colours.  There is no point in
  55.     placing multiple dep statements in your files - sMOVIE finds
  56.     the highest value and uses that throughout.  If you don't
  57.     specify a dep statement anywhere in your file, then you only
  58.     get two colours by default.
  59.  
  60. Command: DFT        Function:    Sets screen to default size.
  61.                     Parameters: None.
  62.  
  63.     Gives you a default size PAL or NTSC screen.  sMOVIE
  64.     automatically performs this command at the start of any
  65.     files that do not contain SIZ or SSZ statements.
  66.  
  67. Command: DLY        Function:    Pauses scrolling of screen.
  68.                     Parameters: Number of ticks to delay.
  69.  
  70.     For example DLY 50 causes a delay of fifty ticks.  A tick
  71.     is either a fiftieth or a sixtieth of a second.  I forget
  72.     which.
  73.  
  74. Command: ESC        Function:    Changes command prefix.
  75.                     Parameters: New command prefix.
  76.  
  77.     For example '|ESC +' changes the command prefix to '+'.
  78.     You would have to use '+ESC |' to change it back again.
  79.     It is good practice to always change the command prefix
  80.     back to the default before the end of your file, and before
  81.     using any FIL commands.  If you don't, you will get problems
  82.     if you later decide to call your file with a FIL command
  83.     from another project.
  84.  
  85. Command: FIL        Function:    Include a file.
  86.                     Parameters: Name of File to be included.
  87.  
  88.     This allows you to create 'subroutines' which you can then
  89.     include in several different files.  If the included file
  90.     isn't in the same directory as the Includer, you will need
  91.     a standard AmigaDos pathname.  FIL commands can be nested to
  92.     any reasonable level.  Circular includes (e.g. File A
  93.     includes File B which includes File A....) will naturally
  94.     cause your Amiga to fall off the end of the World.
  95.  
  96. Command: FNT        Function:    Changes to a different font
  97.                     Parameters:    Font name and pointsize.
  98.  
  99.     For example 'FNT diamond 20' changes to the diamond font
  100.     with a pointsize of 20 (pretty big).  Note that if you
  101.     specify a font then ALL the pointsizes for that font get 
  102.     loaded into memory (don't ask me why), and having a lot of
  103.     fonts open at the same time can use a fair bit of memory.
  104.  
  105. Command: IND        Function:    Indents text (Left margin).
  106.                     Parameters: Number of pixels to indent.
  107.  
  108.     This command is overridden by ONC.  Default indent is zero.
  109.     Use 'IND 0' to switch indenting off.
  110.  
  111. Command: LNS        Function:    Draws horizontal lines.
  112.                     Parameters: Number, length, start posn.
  113.  
  114.     Draws <Number> horizontal lines in the current pen colour,
  115.     scrolling them onto the bottom of the display.  The length
  116.     of the line, and the X position of the left hand end are
  117.     specified in pixels.  This command allows you to create
  118.     (very) simple graphics.
  119.  
  120. Command: OFC        Function:    Turns off automatic centring.
  121.                     Parameters: None.
  122.  
  123.     This disables automatic centring of text.  This is the
  124.     default setting, so this command will only ever be used
  125.     with....
  126.  
  127. Command: ONC        Function:    Turns on automatic centring.
  128.                     Parameters: None.
  129.  
  130.     This causes the centring of all following text up to the
  131.     next OFC command.
  132.  
  133. Command: PLT        Function:    Specifies pallette for a colour.
  134.                     Parameters: Colour Number, Red, Green, Blue.
  135.  
  136.     Lets you assign one of 4096 colours to a colour Number.
  137.     Red, Green and Blue must be numbers in the range 0 to 15.
  138.     If you have not used DEP in your file then Number should be
  139.     0 or 1.  If you have specified DEP 4, then Number can be 0,
  140.     1,2,.... 14,15.  Note that the border around the screen is
  141.     always colour 0 (but you can use it on the screen as well).
  142.  
  143. Command: RST        Function:    Restart from beginning of file.
  144.                     Parameters: None.
  145.  
  146.     If you put a RST at the end of your file then sMOVIE will
  147.     keep running around it until you hit the mouse.  This lets
  148.     you use sMOVIE to display adverts in a shop window or
  149.     whatever.
  150.  
  151. Command: SIZ        Function:    Set screen sizes.
  152.                     Parameters: Mode,Width,Height,X,Y,Q.
  153.     
  154.     Mode must be the word HIRES or LORES (Lower case is valid).
  155.     Width and height are what you would expect.  X and Y specify
  156.     the position of the top left hand corner of the 'display
  157.     window'. Q specifies how much of the left hand part of the
  158.     page is NOT displayed.  All figures are in pixels.  If you
  159.     don't know the sizes of Amiga screens, they are roughly
  160.     640 pixels wide (or 320 in LORES) by 256 pixels down (only
  161.     200 if you have an NTSC machine).
  162.  
  163. Command: SPC        Function:    Controls vertical spacing.
  164.                     Parameters: Number of pixels between text.
  165.  
  166.     SPC specifies the number of blank lines (pixels) between
  167.     each row of text.  The default value is 2.  You can use any
  168.     number from 0 up to stupid values.
  169.  
  170. Command: SPD        Function:    Controls scrolling speed.
  171.                     Parameters: TV frames per pixel of scroll.
  172.  
  173.     'SPD 1' causes sMOVIE to scroll the screen 1 pixel for each
  174.     refresh of the screen.  'SPD 2' (Default) waits two frames
  175.     between scrolls and so is twice as slow as 'SPD 1'.  'SPD 0'
  176.     causes sMOVIE to go as fast as it can - which makes the
  177.     scrolling a bit jumpy.  You can specify almost any value for
  178.     SPD, but beyond about 30 things get REALLY lethargic. Note
  179.     that the user can overide any SPD settings by moving the
  180.     mouse during playback.
  181.  
  182. Command: SSZ        Function:    Smooth Resizing of screen.
  183.                     Parameters: Steps,Delay,Width,Height,X,Y,Q.
  184.  
  185.     This is the one that lets you create all the clever special
  186.     effects.  Steps is the number of views to be made as
  187.     intermediates between the old and the new sizes.  Delay
  188.     works rather like SPD (i.e. small values for a fast resize).
  189.     The other parameters are the final size of the screen as per
  190.     the SIZ command above.  If you're going to use this one, you
  191.     should have at least one SIZ or DFT command somewhere in
  192.     your file.
  193.  
  194. Command: TAB        Function:    Specifies how TABS are handled.
  195.                     Parameters: Tab value.
  196.  
  197.     TAB defaults to 8, which makes it behave the same as Type
  198.     etc.  You can alter it to any value (e.g. it's set at 4 for
  199.     this file).  When using Non-Proportional fonts, TAB can have
  200.     unexpected results.
  201.  
  202. That's yer lot!
  203. ================================================================